home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3c / timer_settime.z / timer_settime
Encoding:
Text File  |  2002-10-03  |  5.6 KB  |  132 lines
  1.  
  2.  
  3.  
  4. ttttiiiimmmmeeeerrrr____sssseeeettttttttiiiimmmmeeee((((3333CCCC))))                                            ttttiiiimmmmeeeerrrr____sssseeeettttttttiiiimmmmeeee((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt_iiii_mmmm_eeee_rrrr______ssss_eeee_tttt_tttt_iiii_mmmm_eeee - set the expiration time for a posix timer
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_tttt_iiii_mmmm_eeee_...._hhhh_>>>>
  13.      _iiii_nnnn_tttt _tttt_iiii_mmmm_eeee_rrrr______ssss_eeee_tttt_tttt_iiii_mmmm_eeee _((((_tttt_iiii_mmmm_eeee_rrrr______tttt _t_i_m_e_r_i_d_,,,, _iiii_nnnn_tttt _f_l_a_g_s_,,,,
  14.      _cccc_oooo_nnnn_ssss_tttt _ssss_tttt_rrrr_uuuu_cccc_tttt _iiii_tttt_iiii_mmmm_eeee_rrrr_ssss_pppp_eeee_cccc _****_v_a_l_u_e_,,,, _ssss_tttt_rrrr_uuuu_cccc_tttt _iiii_tttt_iiii_mmmm_eeee_rrrr_ssss_pppp_eeee_cccc _****_o_v_a_l_u_e_))))_;;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _tttt_iiii_mmmm_eeee_rrrr______ssss_eeee_tttt_tttt_iiii_mmmm_eeee sets the expiration time for the posix timer named by
  18.      _t_i_m_e_r_i_d.  The _tttt_iiii_mmmm_eeee_ssss_pppp_eeee_cccc______tttt _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee field of _v_a_l_u_e is used to specify the
  19.      desired timer expiration time.  If the timer was previously set and has
  20.      not expired, then the timer is reset to the specified _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee.  In the
  21.      event _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee is set to zero, the timer is disarmed.
  22.  
  23.      By default, posix timers interpret specified expiration times to be
  24.      relative to the time of the _tttt_iiii_mmmm_eeee_rrrr______ssss_eeee_tttt_tttt_iiii_mmmm_eeee call.  Therefore, the timer
  25.      will expire in _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee nanoseconds from when the call is made.  This
  26.      behavior, however, may be altered using the _f_l_a_g_s parameter.  If the
  27.      _TTTT_IIII_MMMM_EEEE_RRRR______AAAA_BBBB_SSSS_TTTT_IIII_MMMM_EEEE _f_l_a_g is set, then the timer will interpret the specified
  28.      expiration time to be absolute in respect to the clock associated with
  29.      _t_i_m_e_r_i_d.  Hence, the timer will expire when the clock reaches the
  30.      specified _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee.  If _TTTT_IIII_MMMM_EEEE_RRRR______AAAA_BBBB_SSSS_TTTT_IIII_MMMM_EEEE is selected and the specified
  31.      expiration time has already elapsed, the call will succeed and expiration
  32.      notification will be delivered.
  33.  
  34.      The periodic interval time for which subsequent timer expirations occur
  35.      may be set using the _iiii_tttt______iiii_nnnn_tttt_eeee_rrrr_vvvv_aaaa_llll field of _v_a_l_u_e.  If _iiii_tttt______iiii_nnnn_tttt_eeee_rrrr_vvvv_aaaa_llll is set
  36.      to zero, then the timer will only expire once, as specified by _iiii_tttt______vvvv_aaaa_llll_uuuu_eeee.
  37.  
  38.      If _o_v_a_l_u_e is not set to _NNNN_UUUU_LLLL_LLLL, then the previous time remaining before
  39.      _t_i_m_e_r_i_d expiration is stored at memory address _o_v_a_l_u_e.
  40.  
  41.      _tttt_iiii_mmmm_eeee_rrrr______ssss_eeee_tttt_tttt_iiii_mmmm_eeee will fail if one or more of the following are true:
  42.  
  43.      [EINVAL]    The _t_i_m_e_r_i_d does not name a valid posix timer.
  44.  
  45.      [EINVAL]    _v_a_l_u_e contained a nanosecond value greater than 1000 million
  46.                  or less than zero.
  47.  
  48.      [EFAULT]    The address specified by either _v_a_l_u_e or _o_v_a_l_u_e is outside
  49.                  the range of the address space of the calling process.
  50.  
  51. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  52.      timer_create(3C), timer_delete(3C), timer_getoverrun(3C),
  53.      timer_gettime(3C), clock_settime(2), clock_gettime(2), clock_getres(2),
  54.      getitimer(2), setiitimer(2)
  55.  
  56.  
  57.  
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. ttttiiiimmmmeeeerrrr____sssseeeettttttttiiiimmmmeeee((((3333CCCC))))                                            ttttiiiimmmmeeeerrrr____sssseeeettttttttiiiimmmmeeee((((3333CCCC))))
  70.  
  71.  
  72.  
  73. DIAGNOSTICS
  74.      Upon successful completion, a value of 0 is returned to the calling
  75.      process. Otherwise, a value of -1 is returned and _eeee_rrrr_rrrr_nnnn_oooo is set to
  76.      indicate the error.
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.